<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.9.1" />
<title>tronpytool.manager API documentation</title>
<meta name="description" content="tronpytool.manager
…" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>tronpytool.manager</code></h1>
</header>
<section id="section-intro">
<h1 id="tronpytoolmanager">tronpytool.manager</h1>
<p>This class is designed to configure and
define nodes for different types.</p>
<p>:copyright: © 2019 by the iEXBase.
:license: MIT License</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">#!/usr/bin/env python
# --------------------------------------------------------------------
# Copyright (c) iEXBase. All rights reserved.
# Licensed under the MIT License.
# See License.txt in the project root for license information.
# --------------------------------------------------------------------

&#34;&#34;&#34;
    tronpytool.manager
    ===============

    This class is designed to configure and
    define nodes for different types.

    :copyright: © 2019 by the iEXBase.
    :license: MIT License
&#34;&#34;&#34;
from trx_utils import is_string

from tronpytool.constants import DEFAULT_NODES
from tronpytool.providers.http import HttpProvider

# In this variable, you can specify the base paths
# to test the connection with the nodes.
# It is advisable to leave the settings unchanged.
STATUS_PAGE = {
    &#39;full_node&#39;: &#39;/wallet/getnowblock&#39;,
    &#39;solidity_node&#39;: &#39;/walletsolidity/getnowblock&#39;,
    &#39;event_server&#39;: &#39;/healthcheck&#39;
}


class TronManager(object):
    &#34;&#34;&#34;This class is designed to configure and define nodes
    for different types.

    &#34;&#34;&#34;

    _providers = None

    def __init__(self, tron, providers):
        &#34;&#34;&#34;Create new manager tron instance

        Args:
            tron: The tron implementation
            providers: List of providers

        &#34;&#34;&#34;
        self.tron = tron
        self.providers = providers
        self.preferred_node = None

        for key, value in self.providers.items():
            # This condition checks the nodes,
            # if the link to the node is not specified,
            # we insert the default value to avoid an error.
            if not providers[key]:
                self.providers[key] = HttpProvider(DEFAULT_NODES[key])

            # If the type of the accepted provider is lower-case,
            # then we transform it to “HttpProvider”,
            if is_string(value):
                self.providers[key] = HttpProvider(value)
            self.providers[key].status_page = STATUS_PAGE[key]

    @property
    def providers(self):
        &#34;&#34;&#34;Getting a list of all providers

        &#34;&#34;&#34;
        return self._providers or tuple()

    @providers.setter
    def providers(self, value) -&gt; None:
        &#34;&#34;&#34;Add a new provider

        &#34;&#34;&#34;
        self._providers = value

    @property
    def full_node(self) -&gt; HttpProvider:
        &#34;&#34;&#34;Getting and managing paths to a full node

        &#34;&#34;&#34;
        if &#39;full_node&#39; not in self.providers:
            raise ValueError(&#39;Full node is not activated.&#39;)
        return self.providers.get(&#39;full_node&#39;)

    @property
    def solidity_node(self) -&gt; HttpProvider:
        &#34;&#34;&#34;Getting and managing paths to a solidity node

        &#34;&#34;&#34;
        if &#39;solidity_node&#39; not in self.providers:
            raise ValueError(&#39;Solidity node is not activated.&#39;)
        return self.providers.get(&#39;solidity_node&#39;)

    @property
    def event_server(self) -&gt; HttpProvider:
        &#34;&#34;&#34;Getting and managing paths to a event server

        &#34;&#34;&#34;
        if &#39;event_server&#39; not in self.providers:
            raise ValueError(&#39;Event server is not activated.&#39;)
        return self.providers.get(&#39;event_server&#39;)

    def request(self, url, params=None, method=None):
        &#34;&#34;&#34;Prepare and route the request object according to the manager&#39;s configuration.

        Args:
            url (str): Path to send
            params (dict): Options
            method (str): Request method

        &#34;&#34;&#34;
        method = &#39;post&#39; if method is None else method

        # In this variable, we divide the resulting reference
        # into 2 parts to determine the type of node
        split = url[1:].split(&#39;/&#39;, 2)

        if split[0] in (&#39;walletsolidity&#39;, &#39;walletextension&#39;,):
            return self.solidity_node.request(url, json=params, method=method)
        elif split[0] in (&#39;wallet&#39;,):
            return self.full_node.request(url, json=params, method=method)
        elif split[0] in (&#39;event&#39;, &#39;healthcheck&#39;,):
            return self.event_server.request(url, json=params, method=method)

        raise ValueError(&#39;Could not determine the type of node&#39;)

    def is_connected(self):
        &#34;&#34;&#34;Check connection with providers&#34;&#34;&#34;
        is_node = dict()
        for key, value in self.providers.items():
            is_node.update({key: value.is_connected()})
        return is_node</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="tronpytool.manager.TronManager"><code class="flex name class">
<span>class <span class="ident">TronManager</span></span>
<span>(</span><span>tron, providers)</span>
</code></dt>
<dd>
<div class="desc"><p>This class is designed to configure and define nodes
for different types.</p>
<p>Create new manager tron instance</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>tron</code></strong></dt>
<dd>The tron implementation</dd>
<dt><strong><code>providers</code></strong></dt>
<dd>List of providers</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class TronManager(object):
    &#34;&#34;&#34;This class is designed to configure and define nodes
    for different types.

    &#34;&#34;&#34;

    _providers = None

    def __init__(self, tron, providers):
        &#34;&#34;&#34;Create new manager tron instance

        Args:
            tron: The tron implementation
            providers: List of providers

        &#34;&#34;&#34;
        self.tron = tron
        self.providers = providers
        self.preferred_node = None

        for key, value in self.providers.items():
            # This condition checks the nodes,
            # if the link to the node is not specified,
            # we insert the default value to avoid an error.
            if not providers[key]:
                self.providers[key] = HttpProvider(DEFAULT_NODES[key])

            # If the type of the accepted provider is lower-case,
            # then we transform it to “HttpProvider”,
            if is_string(value):
                self.providers[key] = HttpProvider(value)
            self.providers[key].status_page = STATUS_PAGE[key]

    @property
    def providers(self):
        &#34;&#34;&#34;Getting a list of all providers

        &#34;&#34;&#34;
        return self._providers or tuple()

    @providers.setter
    def providers(self, value) -&gt; None:
        &#34;&#34;&#34;Add a new provider

        &#34;&#34;&#34;
        self._providers = value

    @property
    def full_node(self) -&gt; HttpProvider:
        &#34;&#34;&#34;Getting and managing paths to a full node

        &#34;&#34;&#34;
        if &#39;full_node&#39; not in self.providers:
            raise ValueError(&#39;Full node is not activated.&#39;)
        return self.providers.get(&#39;full_node&#39;)

    @property
    def solidity_node(self) -&gt; HttpProvider:
        &#34;&#34;&#34;Getting and managing paths to a solidity node

        &#34;&#34;&#34;
        if &#39;solidity_node&#39; not in self.providers:
            raise ValueError(&#39;Solidity node is not activated.&#39;)
        return self.providers.get(&#39;solidity_node&#39;)

    @property
    def event_server(self) -&gt; HttpProvider:
        &#34;&#34;&#34;Getting and managing paths to a event server

        &#34;&#34;&#34;
        if &#39;event_server&#39; not in self.providers:
            raise ValueError(&#39;Event server is not activated.&#39;)
        return self.providers.get(&#39;event_server&#39;)

    def request(self, url, params=None, method=None):
        &#34;&#34;&#34;Prepare and route the request object according to the manager&#39;s configuration.

        Args:
            url (str): Path to send
            params (dict): Options
            method (str): Request method

        &#34;&#34;&#34;
        method = &#39;post&#39; if method is None else method

        # In this variable, we divide the resulting reference
        # into 2 parts to determine the type of node
        split = url[1:].split(&#39;/&#39;, 2)

        if split[0] in (&#39;walletsolidity&#39;, &#39;walletextension&#39;,):
            return self.solidity_node.request(url, json=params, method=method)
        elif split[0] in (&#39;wallet&#39;,):
            return self.full_node.request(url, json=params, method=method)
        elif split[0] in (&#39;event&#39;, &#39;healthcheck&#39;,):
            return self.event_server.request(url, json=params, method=method)

        raise ValueError(&#39;Could not determine the type of node&#39;)

    def is_connected(self):
        &#34;&#34;&#34;Check connection with providers&#34;&#34;&#34;
        is_node = dict()
        for key, value in self.providers.items():
            is_node.update({key: value.is_connected()})
        return is_node</code></pre>
</details>
<h3>Instance variables</h3>
<dl>
<dt id="tronpytool.manager.TronManager.event_server"><code class="name">var <span class="ident">event_server</span> : <a title="tronpytool.providers.http.HttpProvider" href="providers/http.html#tronpytool.providers.http.HttpProvider">HttpProvider</a></code></dt>
<dd>
<div class="desc"><p>Getting and managing paths to a event server</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@property
def event_server(self) -&gt; HttpProvider:
    &#34;&#34;&#34;Getting and managing paths to a event server

    &#34;&#34;&#34;
    if &#39;event_server&#39; not in self.providers:
        raise ValueError(&#39;Event server is not activated.&#39;)
    return self.providers.get(&#39;event_server&#39;)</code></pre>
</details>
</dd>
<dt id="tronpytool.manager.TronManager.full_node"><code class="name">var <span class="ident">full_node</span> : <a title="tronpytool.providers.http.HttpProvider" href="providers/http.html#tronpytool.providers.http.HttpProvider">HttpProvider</a></code></dt>
<dd>
<div class="desc"><p>Getting and managing paths to a full node</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@property
def full_node(self) -&gt; HttpProvider:
    &#34;&#34;&#34;Getting and managing paths to a full node

    &#34;&#34;&#34;
    if &#39;full_node&#39; not in self.providers:
        raise ValueError(&#39;Full node is not activated.&#39;)
    return self.providers.get(&#39;full_node&#39;)</code></pre>
</details>
</dd>
<dt id="tronpytool.manager.TronManager.providers"><code class="name">var <span class="ident">providers</span></code></dt>
<dd>
<div class="desc"><p>Getting a list of all providers</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@property
def providers(self):
    &#34;&#34;&#34;Getting a list of all providers

    &#34;&#34;&#34;
    return self._providers or tuple()</code></pre>
</details>
</dd>
<dt id="tronpytool.manager.TronManager.solidity_node"><code class="name">var <span class="ident">solidity_node</span> : <a title="tronpytool.providers.http.HttpProvider" href="providers/http.html#tronpytool.providers.http.HttpProvider">HttpProvider</a></code></dt>
<dd>
<div class="desc"><p>Getting and managing paths to a solidity node</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@property
def solidity_node(self) -&gt; HttpProvider:
    &#34;&#34;&#34;Getting and managing paths to a solidity node

    &#34;&#34;&#34;
    if &#39;solidity_node&#39; not in self.providers:
        raise ValueError(&#39;Solidity node is not activated.&#39;)
    return self.providers.get(&#39;solidity_node&#39;)</code></pre>
</details>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="tronpytool.manager.TronManager.is_connected"><code class="name flex">
<span>def <span class="ident">is_connected</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Check connection with providers</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def is_connected(self):
    &#34;&#34;&#34;Check connection with providers&#34;&#34;&#34;
    is_node = dict()
    for key, value in self.providers.items():
        is_node.update({key: value.is_connected()})
    return is_node</code></pre>
</details>
</dd>
<dt id="tronpytool.manager.TronManager.request"><code class="name flex">
<span>def <span class="ident">request</span></span>(<span>self, url, params=None, method=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Prepare and route the request object according to the manager's configuration.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>url</code></strong> :&ensp;<code>str</code></dt>
<dd>Path to send</dd>
<dt><strong><code>params</code></strong> :&ensp;<code>dict</code></dt>
<dd>Options</dd>
<dt><strong><code>method</code></strong> :&ensp;<code>str</code></dt>
<dd>Request method</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def request(self, url, params=None, method=None):
    &#34;&#34;&#34;Prepare and route the request object according to the manager&#39;s configuration.

    Args:
        url (str): Path to send
        params (dict): Options
        method (str): Request method

    &#34;&#34;&#34;
    method = &#39;post&#39; if method is None else method

    # In this variable, we divide the resulting reference
    # into 2 parts to determine the type of node
    split = url[1:].split(&#39;/&#39;, 2)

    if split[0] in (&#39;walletsolidity&#39;, &#39;walletextension&#39;,):
        return self.solidity_node.request(url, json=params, method=method)
    elif split[0] in (&#39;wallet&#39;,):
        return self.full_node.request(url, json=params, method=method)
    elif split[0] in (&#39;event&#39;, &#39;healthcheck&#39;,):
        return self.event_server.request(url, json=params, method=method)

    raise ValueError(&#39;Could not determine the type of node&#39;)</code></pre>
</details>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul>
<li><a href="#tronpytoolmanager">tronpytool.manager</a></li>
</ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="tronpytool" href="index.html">tronpytool</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="tronpytool.manager.TronManager" href="#tronpytool.manager.TronManager">TronManager</a></code></h4>
<ul class="two-column">
<li><code><a title="tronpytool.manager.TronManager.event_server" href="#tronpytool.manager.TronManager.event_server">event_server</a></code></li>
<li><code><a title="tronpytool.manager.TronManager.full_node" href="#tronpytool.manager.TronManager.full_node">full_node</a></code></li>
<li><code><a title="tronpytool.manager.TronManager.is_connected" href="#tronpytool.manager.TronManager.is_connected">is_connected</a></code></li>
<li><code><a title="tronpytool.manager.TronManager.providers" href="#tronpytool.manager.TronManager.providers">providers</a></code></li>
<li><code><a title="tronpytool.manager.TronManager.request" href="#tronpytool.manager.TronManager.request">request</a></code></li>
<li><code><a title="tronpytool.manager.TronManager.solidity_node" href="#tronpytool.manager.TronManager.solidity_node">solidity_node</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
</footer>
</body>
</html>